Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add collection tags to index [FC-0062] #35483

Merged
merged 9 commits into from
Sep 17, 2024
Merged

feat: Add collection tags to index [FC-0062] #35483

merged 9 commits into from
Sep 17, 2024

Conversation

ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Sep 13, 2024 •
edited
Loading

Description

Adds tags of library collections into meilisearch index.

Supporting information

Testing instructions

from openedx.core.djangoapps.content_libraries import api
from openedx.core.djangoapps.content_tagging import api as tagging_api
from opaque_keys.edx.locator import LibraryLocatorV2, LibraryCollectionLocator
from openedx_tagging.core.tagging.models import Taxonomy

lib_key_str = "lib:<your lib key>"
library_key = LibraryLocatorV2.from_string(lib_key_str)
taxonomy = Taxonomy.objects.get(name='MultiOrgTaxonomy')
tags = ['multi org taxonomy tag 0']
collection_key = "FAL-3817"

api.create_library_collection(library_key, collection_key, title="Collection FAL-3817")
collection_usage_key = api.get_library_collection_usage_key(library_key, collection_key)
tagging_api.tag_object(str(collection_usage_key), taxonomy, tags)

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 13, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 13, 2024 •
edited
Loading

Thanks for the pull request, @ChrisChV!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@ChrisChV ChrisChV marked this pull request as draft September 13, 2024 03:42
@ChrisChV ChrisChV force-pushed the chris/FAL-3817-tags-collection-to-index branch 2 times, most recently from 57591e4 to f0d83ff Compare September 13, 2024 14:46
@ChrisChV ChrisChV marked this pull request as ready for review September 13, 2024 15:43
rpenido
rpenido approved these changes Sep 14, 2024
View reviewed changes
Copy link
Contributor

@rpenido rpenido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
Thank you for your work, @ChrisChV!

  • I tested this using the instructions from the PR
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

I think we just need to add the 'usage_key' in the collection doc on meilisearch.
I have a scratch PR here: open-craft#687

openedx/core/djangoapps/content_libraries/api.py
library_key: LibraryLocatorV2,
collection_key: str,
# As an optimization, callers may pass in a pre-fetched ContentLibrary instance
content_library: ContentLibrary | None = None,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! 👍

@ChrisChV
Copy link
Contributor Author

I think we just need to add the 'usage_key' in the collection doc on meilisearch.

@rpenido Thanks I added it here 6fb3027. I used a different approach.

bradenmacdonald
bradenmacdonald approved these changes Sep 16, 2024
View reviewed changes
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - please just remove the print. You can merge the PR tomorrow during the merge window.

openedx/core/djangoapps/content/search/tests/test_documents.py Outdated Show resolved Hide resolved
openedx/core/djangoapps/content/search/tests/test_documents.py Outdated Show resolved Hide resolved
pomegranited
pomegranited approved these changes Sep 16, 2024
View reviewed changes
Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 One tiny nit, but this is working great, thank you @ChrisChV !

  • I tested this using the PR test instructions
  • I read through the code
  • I checked for accessibility issues N/A
  • Includes documentation N/A
  • User-facing strings are extracted for translation N/A

openedx/core/djangoapps/content_libraries/api.py Outdated Show resolved Hide resolved
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Sep 17, 2024
@ChrisChV ChrisChV force-pushed the chris/FAL-3817-tags-collection-to-index branch from 4599c66 to a1646ee Compare September 17, 2024 16:05
@ChrisChV ChrisChV merged commit 5927be7 into openedx:master Sep 17, 2024
49 checks passed
@ChrisChV ChrisChV deleted the chris/FAL-3817-tags-collection-to-index branch September 17, 2024 16:52
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rpenido rpenido rpenido approved these changes

@bradenmacdonald bradenmacdonald bradenmacdonald approved these changes

@pomegranited pomegranited pomegranited approved these changes

Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@ChrisChV @openedx-webhooks @edx-pipeline-bot @rpenido @bradenmacdonald @pomegranited @mphilbrick211